/*
 * Copyright 2009 XueSong Guo.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package cn.webwheel.utils;

/**
 * 页面模板结果
 */
public class TemplateResult {

    private String path;
    private Class cls;
    private Object com;

    private String templateCharset;
    private String renderCharset;
    private String contentType;

    /**
     * 构造方法
     * @param path 页面模板文件的位置，为相对应用web根目录的绝对地址，如“/index.html”、“/WEB-INF/some/dir/somepage.template”
     * @param cls 页面组件类型
     * @param com 页面组件实例
     */
    public TemplateResult(String path, Class cls, Object com) {
        if (path == null || cls == null || com == null) {
            throw new NullPointerException();
        }
        this.path = path;
        this.cls = cls;
        this.com = com;
    }

    /**
     * 构造方法，使用{@link cn.webwheel.ObjectFactory#getInstanceOf(Class)}方法获得页面组件类型的实例
     * @param path 页面模板文件的位置
     * @param cls 页面组件类型
     */
    public TemplateResult(String path, Class cls) {
        if (path == null || cls == null) {
            throw new NullPointerException();
        }
        this.path = path;
        this.cls = cls;
    }

    /**
     * 构造方法，使用页面组件的实例类型作为页面组件类型
     * @param path 页面模板文件的位置
     * @param com 页面组件
     */
    public TemplateResult(String path, Object com) {
        this(path, com.getClass(), com);
    }

    /**
     * 构造方法，使用在{@link cn.webwheel.utils.TemplateResultInterpreter}中绑定的页面模板文件位置来查找此类型的页面模板文件位置
     * @param cls 页面组件类型
     * @param com 页面组件实例
     */
    public TemplateResult(Class cls, Object com) {
        if (cls == null || com == null) {
            throw new NullPointerException();
        }
        this.cls = cls;
        this.com = com;
    }

    /**
     * 构造方法
     * @param cls 页面组件类型
     */
    public TemplateResult(Class cls) {
        if (cls == null) {
            throw new NullPointerException();
        }
        this.cls = cls;
    }

    /**
     * 构造方法
     * @param com 页面组件实例
     */
    public TemplateResult(Object com) {
        this(com.getClass(), com);
    }

    /**
     * 获得页面模板文件位置
     * @return 页面模板文件位置
     */
    public String getPath() {
        return path;
    }

    /**
     * 获得页面组件类型
     * @return 页面组件类型
     */
    public Class getCls() {
        return cls;
    }

    /**
     * 获得页面组件实例
     * @return 获得页面组件实例
     */
    public Object getCom() {
        return com;
    }

    /**
     * 获得页面模板文件的文本编码
     * @return 编码
     */
    public String getTemplateCharset() {
        return templateCharset;
    }

    /**
     * 设置页面模板文件的文本编码
     * @param templateCharset 编码
     */
    public void setTemplateCharset(String templateCharset) {
        this.templateCharset = templateCharset;
    }

    /**
     * 获得页面模板在浏览器渲染时的编码
     * @return 编码
     */
    public String getRenderCharset() {
        return renderCharset;
    }

    /**
     * 设置页面模板在浏览器渲染时的编码
     * @param renderCharset 编码
     */
    public void setRenderCharset(String renderCharset) {
        this.renderCharset = renderCharset;
    }

    /**
     * 获得页面模板在浏览器渲染的mime内容类型
     * @return mime内容类型
     */
    public String getContentType() {
        return contentType;
    }

    /**
     * 设置页面模板在浏览器渲染的mime内容类型，如“application/xml”，“text/vnd.wap.wml”等
     * @param contentType mime内容类型
     */
    public void setContentType(String contentType) {
        this.contentType = contentType;
    }
}
